/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.action.admin.indices.mapping.put;

import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.index.Index;

/**
 * A validator that validates a {@link PutMappingRequest} before executing it.
 * @see TransportPutMappingAction.RequestValidators
 */
public interface MappingRequestValidator {

    /**
     * Validates a given put mapping request with its associated concrete indices and the current state.
     *
     * @param request the request to validate
     * @param state   the current cluster state
     * @param indices the concrete indices that associated with the given put mapping request
     * @return a non-null exception indicates a reason that the given request should be aborted; otherwise returns null.
     */
    Exception validateRequest(PutMappingRequest request, ClusterState state, Index[] indices);
}
